Public Class StringList As azlwListCarrier

Properties Detail

• isBlank (Get)

  Public Property Get isBlank As Boolean
  Flag indicating if the Object's content contains only blank strings

• TaggedValues (Get)

  Public Property Get TaggedValues As StringList
  Tagged Values of the object NOTE: It is expected that this property will be overridden by child classes

• uniqueValues (Get)

  Public Property Get uniqueValues As Variant
  array containing unique values from the object

Methods Detail

• getContent

  Public Function getContent() As Variant
  Gets the content list for the object

• getValue

  Public Function getValue(key As String) As String
  Gets the Value for the named element within the object.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Key for the element whose value is being retrieved

• replaceMoustacheTags

  Public Function replaceMoustacheTags(source As StringsCarrier) As String
  Replaces substring tags in a source StringsCarrier with string values from the object. Searches a source StringsCarrier for instances of moustache tags matching the object's keys, and replaces them with the associated string values. Object's keys will be moustached prior to comparison, wrapped with double open and double close curly braces: {{key}}
  idx	Argument	Data Type	Attributes	Comments
  1	source	StringsCarrier		StringsCarrier within which to search for tags

• replaceStringTags

  Public Function replaceStringTags(source As String) As String
  Replaces substring tags in a source string with string values from the object. Searches a source string for instances of tags matching the object's keys, and replaces them with the associated string values.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String within which to search for tags

• writeToFile

  Public Function writeToFile(target As String) As Long
  Writes Contents of object to a Text File. IMPORTANT NOTE: Existing files will be OVERWRITTEN! It is up to the calling code to pre-check for existence of file.
  idx	Argument	Data Type	Attributes	Comments
  1	target	String		Filepath of file to be written.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if target filepath is blank.
  MSG_OPERATION_FAILED	1000	or other file system exception on failure.

• addAll

  Public Sub addAll(source As StringList)
  Adds all elements of another StringList to this object.
  idx	Argument	Data Type	Attributes	Comments
  1	source	StringList		StringList containining elements to be added

• clear

  Public Sub clear()
  Clears the object's content

• clearBlanks

  Public Sub clearBlanks()
  Erases all blank elements from the internal List.

• Delete

  Public Sub Delete()
  Clears the object's content prior to deletion

• New

  Public Sub New()

• removeElement

  Public Sub removeElement(key As String)
  Removes an element from the internal list
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Unique key identifying the element to be removed

• setElementValue

  Public Sub setElementValue(key As String, value As Variant)
  Sets the value for an element in the list
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Unique key identifying the element whose value should be set
  2	value	Variant		Value to be associated with the key